com.inscoper.nbo.Objective

Represents the XML element Objective. More...

Inherits from com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Objective()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(ObjectiveID_Type value) Sets the value of the ID attribute.
ObjectiveID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setMagnification(float value) Sets the value of the Magnification attribute.
float	getMagnification() Returns the value of the Magnification attribute.
void	setLensNA(float value) Sets the value of the LensNA attribute.
float	getLensNA() Returns the value of the LensNA attribute.
void	setCorrection(ObjectiveCorrection_Type value) Sets the value of the Correction attribute.
ObjectiveCorrection_Type	getCorrection() Returns the value of the Correction attribute.
void	resetCorrection() Resets the Correction attribute to an unset state.
boolean	hasCorrection() Checks whether the optional Correction attribute is present.
void	setImmersionType(ImmersionTypeList_Type value) Sets the value of the ImmersionType attribute.
ImmersionTypeList_Type	getImmersionType() Returns the value of the ImmersionType attribute.
void	resetImmersionType() Resets the ImmersionType attribute to an unset state.
boolean	hasImmersionType() Checks whether the optional ImmersionType attribute is present.
void	setInfinityCorrected(boolean value) Sets the value of the InfinityCorrected attribute.
boolean	getInfinityCorrected() Returns the value of the InfinityCorrected attribute.
void	setContrastModulation(ContrastModulationPlate_Type value) Sets the value of the ContrastModulation attribute.
ContrastModulationPlate_Type	getContrastModulation() Returns the value of the ContrastModulation attribute.
void	resetContrastModulation() Resets the ContrastModulation attribute to an unset state.
boolean	hasContrastModulation() Checks whether the optional ContrastModulation attribute is present.
void	setDIC(boolean value) Sets the value of the DIC attribute.
boolean	getDIC() Returns the value of the DIC attribute.
void	setLightType(ObjectiveLightType_Type value) Sets the value of the LightType attribute.
ObjectiveLightType_Type	getLightType() Returns the value of the LightType attribute.
void	resetLightType() Resets the LightType attribute to an unset state.
boolean	hasLightType() Checks whether the optional LightType attribute is present.
void	setDippingMedium(DippingType_Type value) Sets the value of the DippingMedium attribute.
DippingType_Type	getDippingMedium() Returns the value of the DippingMedium attribute.
void	resetDippingMedium() Resets the DippingMedium attribute to an unset state.
boolean	hasDippingMedium() Checks whether the optional DippingMedium attribute is present.
void	setWorkingDistance(float value) Sets the value of the WorkingDistance attribute.
float	getWorkingDistance() Returns the value of the WorkingDistance attribute.
void	setWorkingDistanceUnit(UnitsLength_Type value) Sets the value of the WorkingDistanceUnit attribute.
UnitsLength_Type	getWorkingDistanceUnit() Returns the value of the WorkingDistanceUnit attribute.
void	resetWorkingDistanceUnit() Resets the WorkingDistanceUnit attribute to an unset state.
boolean	hasWorkingDistanceUnit() Checks whether the optional WorkingDistanceUnit attribute is present.
void	setCorrectionCollar(boolean value) Sets the value of the CorrectionCollar attribute.
boolean	getCorrectionCollar() Returns the value of the CorrectionCollar attribute.
void	setCorrectionCollarType(CorrectionCollarTypeList_Type value) Sets the value of the CorrectionCollarType attribute.
CorrectionCollarTypeList_Type	getCorrectionCollarType() Returns the value of the CorrectionCollarType attribute.
void	resetCorrectionCollarType() Resets the CorrectionCollarType attribute to an unset state.
boolean	hasCorrectionCollarType() Checks whether the optional CorrectionCollarType attribute is present.
void	setPhaseContrastDesignation(PhaseContrastDesignationType_Type value) Sets the value of the PhaseContrastDesignation attribute.
PhaseContrastDesignationType_Type	getPhaseContrastDesignation() Returns the value of the PhaseContrastDesignation attribute.
void	resetPhaseContrastDesignation() Resets the PhaseContrastDesignation attribute to an unset state.
boolean	hasPhaseContrastDesignation() Checks whether the optional PhaseContrastDesignation attribute is present.
void	setCalibratedMagnification(float value) Sets the value of the CalibratedMagnification attribute.
float	getCalibratedMagnification() Returns the value of the CalibratedMagnification attribute.
void	resetCalibratedMagnification() Resets the CalibratedMagnification attribute to an unset state.
boolean	hasCalibratedMagnification() Checks whether the optional CalibratedMagnification attribute is present.
void	setIris(boolean value) Sets the value of the Iris attribute.
boolean	getIris() Returns the value of the Iris attribute.
void	resetIris() Resets the Iris attribute to an unset state.
boolean	hasIris() Checks whether the optional Iris attribute is present.
void	setObjectiveViewField(float value) Sets the value of the ObjectiveViewField attribute.
float	getObjectiveViewField() Returns the value of the ObjectiveViewField attribute.
void	setImageDistance(float value) Sets the value of the ImageDistance attribute.
float	getImageDistance() Returns the value of the ImageDistance attribute.
void	setImageDistanceUnit(UnitsLength_Type value) Sets the value of the ImageDistanceUnit attribute.
UnitsLength_Type	getImageDistanceUnit() Returns the value of the ImageDistanceUnit attribute.
void	resetImageDistanceUnit() Resets the ImageDistanceUnit attribute to an unset state.
boolean	hasImageDistanceUnit() Checks whether the optional ImageDistanceUnit attribute is present.
void	setFrontFocalLength(float value) Sets the value of the FrontFocalLength attribute.
float	getFrontFocalLength() Returns the value of the FrontFocalLength attribute.
void	resetFrontFocalLength() Resets the FrontFocalLength attribute to an unset state.
boolean	hasFrontFocalLength() Checks whether the optional FrontFocalLength attribute is present.
void	setFrontFocalLengthUnit(UnitsLength_Type value) Sets the value of the FrontFocalLengthUnit attribute.
UnitsLength_Type	getFrontFocalLengthUnit() Returns the value of the FrontFocalLengthUnit attribute.
void	resetFrontFocalLengthUnit() Resets the FrontFocalLengthUnit attribute to an unset state.
boolean	hasFrontFocalLengthUnit() Checks whether the optional FrontFocalLengthUnit attribute is present.
void	setBackFocalLength(float value) Sets the value of the BackFocalLength attribute.
float	getBackFocalLength() Returns the value of the BackFocalLength attribute.
void	resetBackFocalLength() Resets the BackFocalLength attribute to an unset state.
boolean	hasBackFocalLength() Checks whether the optional BackFocalLength attribute is present.
void	setBackFocalLengthUnit(UnitsLength_Type value) Sets the value of the BackFocalLengthUnit attribute.
UnitsLength_Type	getBackFocalLengthUnit() Returns the value of the BackFocalLengthUnit attribute.
void	resetBackFocalLengthUnit() Resets the BackFocalLengthUnit attribute to an unset state.
boolean	hasBackFocalLengthUnit() Checks whether the optional BackFocalLengthUnit attribute is present.
void	setParfocalizingDistance(float value) Sets the value of the ParfocalizingDistance attribute.
float	getParfocalizingDistance() Returns the value of the ParfocalizingDistance attribute.
void	resetParfocalizingDistance() Resets the ParfocalizingDistance attribute to an unset state.
boolean	hasParfocalizingDistance() Checks whether the optional ParfocalizingDistance attribute is present.
void	setParfocalizingDistanceUnit(UnitsLength_Type value) Sets the value of the ParfocalizingDistanceUnit attribute.
UnitsLength_Type	getParfocalizingDistanceUnit() Returns the value of the ParfocalizingDistanceUnit attribute.
void	resetParfocalizingDistanceUnit() Resets the ParfocalizingDistanceUnit attribute to an unset state.
boolean	hasParfocalizingDistanceUnit() Checks whether the optional ParfocalizingDistanceUnit attribute is present.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
Objective	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	Objective(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Objective obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the optional LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.Objective;

Represents the XML element Objective.

The Microscope's Objective lens consists of a lens, its mount, and any associated parts. It is the part of the imaging system, which forms a primary image of the object, either alone or in conjunction with a tube lens. The Objective typically consists of a compound lens consisting of along a common axis.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

function Objective

public Objective()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

function setID

public void setID(
    ObjectiveID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public ObjectiveID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this component.

function setName

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A User-defined Name for this component.

function getName

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A User-defined Name for this component.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

Return: true if the optional attribute has been set, false otherwise

A User-defined Name for this component.

function setMagnification

public void setMagnification(
    float value
)

Sets the value of the Magnification attribute.

Parameters:

value The value to set

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

function getMagnification

public float getMagnification()

Returns the value of the Magnification attribute.

Return: The value of the attribute

This field captures the Magnification of the Objective as specified by the Manufacturer - i.e., 60 represents a 60X lens.

function setLensNA

public void setLensNA(
    float value
)

Sets the value of the LensNA attribute.

Parameters:

value The value to set

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

function getLensNA

public float getLensNA()

Returns the value of the LensNA attribute.

Return: The value of the attribute

This field captures the nominal Numerical Aperture (NA) of this Objective as specified by the Manufactuer, expressed as a floating-point (real) number (e.g. 1.27 NA). NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

function setCorrection

public void setCorrection(
    ObjectiveCorrection_Type value
)

Sets the value of the Correction attribute.

Parameters:

value The value to set

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

function getCorrection

public ObjectiveCorrection_Type getCorrection()

Returns the value of the Correction attribute.

Return: The value of the attribute

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

function resetCorrection

public void resetCorrection()

Resets the Correction attribute to an unset state.

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

function hasCorrection

public boolean hasCorrection()

Checks whether the optional Correction attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the type of optical correction (i.e. chromatic correction, or flatness correction, etc.) associated with this Objective.

function setImmersionType

public void setImmersionType(
    ImmersionTypeList_Type value
)

Sets the value of the ImmersionType attribute.

Parameters:

value The value to set

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

function getImmersionType

public ImmersionTypeList_Type getImmersionType()

Returns the value of the ImmersionType attribute.

Return: The value of the attribute

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

function resetImmersionType

public void resetImmersionType()

Resets the ImmersionType attribute to an unset state.

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

function hasImmersionType

public boolean hasImmersionType()

Checks whether the optional ImmersionType attribute is present.

Return: true if the optional attribute has been set, false otherwise

According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water or glycerol) specified as suitable for use in the space between the front of an immersion lens and the object NOTE Because the immersion liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Please refer to ISO 8036-1 for more details on Immersion Oil. This field describes the general category of the Immersion Liquid this Objective is designed for, according to the Manufacturer. If the general category is not Air, the actual Immersion Liquid that was used during the Acquisition of a specific Image must be specified in Objective Settings.

function setInfinityCorrected

public void setInfinityCorrected(
    boolean value
)

Sets the value of the InfinityCorrected attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

function getInfinityCorrected

public boolean getInfinityCorrected()

Returns the value of the InfinityCorrected attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this Objective is infinity corrected. An Infinity-corrected Objective is corrected for an infinite sample to primary image distance and needs to be used with a Tube Lens of appropriate focal length to obtains its nominal magnification.

function setContrastModulation

public void setContrastModulation(
    ContrastModulationPlate_Type value
)

Sets the value of the ContrastModulation attribute.

Parameters:

value The value to set

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

function getContrastModulation

public ContrastModulationPlate_Type getContrastModulation()

Returns the value of the ContrastModulation attribute.

Return: The value of the attribute

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

function resetContrastModulation

public void resetContrastModulation()

Resets the ContrastModulation attribute to an unset state.

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

function hasContrastModulation

public boolean hasContrastModulation()

Checks whether the optional ContrastModulation attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field specifies the presence in this Objective of a contrast modulation device, such as a Phase Ring (Ph1, Ph2, Ph3), a Hoffman modulator, a Varel modulator, or similar.

function setDIC

public void setDIC(
    boolean value
)

Sets the value of the DIC attribute.

Parameters:

value The value to set

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

function getDIC

public boolean getDIC()

Returns the value of the DIC attribute.

Return: The value of the attribute

This field specifies whether (True) the Objective is designed for Differential Interference Contrast (DIC) or not (False). DIC is a contrast modality due to double-beam interference in which two waves that fall on the object Plane or Image Plane are separated laterally by a distance similar to the minimum resolvable distance.

function setLightType

public void setLightType(
    ObjectiveLightType_Type value
)

Sets the value of the LightType attribute.

Parameters:

value The value to set

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

function getLightType

public ObjectiveLightType_Type getLightType()

Returns the value of the LightType attribute.

Return: The value of the attribute

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

function resetLightType

public void resetLightType()

Resets the LightType attribute to an unset state.

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

function hasLightType

public boolean hasLightType()

Checks whether the optional LightType attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field specifies whether this Objective is designed for a special Light application (e.g., IR or UV).

function setDippingMedium

public void setDippingMedium(
    DippingType_Type value
)

Sets the value of the DippingMedium attribute.

Parameters:

value The value to set

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

function getDippingMedium

public DippingType_Type getDippingMedium()

Returns the value of the DippingMedium attribute.

Return: The value of the attribute

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

function resetDippingMedium

public void resetDippingMedium()

Resets the DippingMedium attribute to an unset state.

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

function hasDippingMedium

public boolean hasDippingMedium()

Checks whether the optional DippingMedium attribute is present.

Return: true if the optional attribute has been set, false otherwise

In case the Immersion Type for this Objective is designated as Dipping, this field captures the type of Dipping Medium this Objective is compatible with. Examples include, water-based (biological buffers, culture media, other water-based solutions) organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); 100% Ethanol].

function setWorkingDistance

public void setWorkingDistance(
    float value
)

Sets the value of the WorkingDistance attribute.

Parameters:

value The value to set

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

function getWorkingDistance

public float getWorkingDistance()

Returns the value of the WorkingDistance attribute.

Return: The value of the attribute

This field reports the Working Distance of this Objective under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

function setWorkingDistanceUnit

public void setWorkingDistanceUnit(
    UnitsLength_Type value
)

Sets the value of the WorkingDistanceUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getWorkingDistanceUnit

public UnitsLength_Type getWorkingDistanceUnit()

Returns the value of the WorkingDistanceUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetWorkingDistanceUnit

public void resetWorkingDistanceUnit()

Resets the WorkingDistanceUnit attribute to an unset state.

No description available in the XSD standard.

function hasWorkingDistanceUnit

public boolean hasWorkingDistanceUnit()

Checks whether the optional WorkingDistanceUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setCorrectionCollar

public void setCorrectionCollar(
    boolean value
)

Sets the value of the CorrectionCollar attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

function getCorrectionCollar

public boolean getCorrectionCollar()

Returns the value of the CorrectionCollar attribute.

Return: The value of the attribute

This field records whether (True) or not (False) the Objective was fitted with a Correction Collar. When using high NA dry Objectives (NA 0.8 or greater), cover glass thickness variations of only a few micrometers, immersion medium, and temperature changes result in dramatic image degradation due to aberration. To compensate for these errors, the more highly corrected Objectives are equipped with a Correction Collar mechanism, which is provided to adjust the central lens group position to compensate for deviations from correct optical path length due to changes in Cover Glass Thickness, the nature of the Immersion Liquid, different Numerical Apertures, and Temperature.

function setCorrectionCollarType

public void setCorrectionCollarType(
    CorrectionCollarTypeList_Type value
)

Sets the value of the CorrectionCollarType attribute.

Parameters:

value The value to set

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

function getCorrectionCollarType

public CorrectionCollarTypeList_Type getCorrectionCollarType()

Returns the value of the CorrectionCollarType attribute.

Return: The value of the attribute

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

function resetCorrectionCollarType

public void resetCorrectionCollarType()

Resets the CorrectionCollarType attribute to an unset state.

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

function hasCorrectionCollarType

public boolean hasCorrectionCollarType()

Checks whether the optional CorrectionCollarType attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the type of Correction Collar with which this Objective is fitted. In case the Objective has more than one Correction Collar please enter "Multi" and provide more details in Description.

function setPhaseContrastDesignation

public void setPhaseContrastDesignation(
    PhaseContrastDesignationType_Type value
)

Sets the value of the PhaseContrastDesignation attribute.

Parameters:

value The value to set

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

function getPhaseContrastDesignation

public PhaseContrastDesignationType_Type getPhaseContrastDesignation()

Returns the value of the PhaseContrastDesignation attribute.

Return: The value of the attribute

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

function resetPhaseContrastDesignation

public void resetPhaseContrastDesignation()

Resets the PhaseContrastDesignation attribute to an unset state.

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

function hasPhaseContrastDesignation

public boolean hasPhaseContrastDesignation()

Checks whether the optional PhaseContrastDesignation attribute is present.

Return: true if the optional attribute has been set, false otherwise

If the Objective is designed for Phase, this field specifies the Phase Contrast type designation (see: https://www.microscopyu.com/techniques/phase-contrast/phase-contrast-Microscope-configuration).

function setCalibratedMagnification

public void setCalibratedMagnification(
    float value
)

Sets the value of the CalibratedMagnification attribute.

Parameters:

value The value to set

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

function getCalibratedMagnification

public float getCalibratedMagnification()

Returns the value of the CalibratedMagnification attribute.

Return: The value of the attribute

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

function resetCalibratedMagnification

public void resetCalibratedMagnification()

Resets the CalibratedMagnification attribute to an unset state.

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

function hasCalibratedMagnification

public boolean hasCalibratedMagnification()

Checks whether the optional CalibratedMagnification attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Magnification of the Objective as measured via a calibration process- i.e., '59.987' for a 60x lens.

function setIris

public void setIris(
    boolean value
)

Sets the value of the Iris attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

function getIris

public boolean getIris()

Returns the value of the Iris attribute.

Return: The value of the attribute

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

function resetIris

public void resetIris()

Resets the Iris attribute to an unset state.

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

function hasIris

public boolean hasIris()

Checks whether the optional Iris attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records whether (True) or not (False) the Objective was fitted with an Iris. Manufacturers offer high NA Objectives, which are equipped with an internal Iris Diaphragm that increases image contrast during digital imaging to compensate for image flare artifacts due to light emitted from areas outside the focal plane. Opening or closing the Iris Diaphragm determines the size of the Objective rear aperture yielding a variable NA range between 0.5 and the Objective's upper limit.

function setObjectiveViewField

public void setObjectiveViewField(
    float value
)

Sets the value of the ObjectiveViewField attribute.

Parameters:

value The value to set

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

function getObjectiveViewField

public float getObjectiveViewField()

Returns the value of the ObjectiveViewField attribute.

Return: The value of the attribute

This field records the maximal diameter of the view field allowed by this Objective, expressed in mm, and measured at the intermediate Image Plane. NB: The field of view is influenced by the magnification and diameter of the ocular (eyepiece) field diaphragm, but also by the limits imposed by the design of the Objective.

function setImageDistance

public void setImageDistance(
    float value
)

Sets the value of the ImageDistance attribute.

Parameters:

value The value to set

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

function getImageDistance

public float getImageDistance()

Returns the value of the ImageDistance attribute.

Return: The value of the attribute

This field records the distance in air between the rear principal Plane of this Objective and the primary Image Plane.

function setImageDistanceUnit

public void setImageDistanceUnit(
    UnitsLength_Type value
)

Sets the value of the ImageDistanceUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getImageDistanceUnit

public UnitsLength_Type getImageDistanceUnit()

Returns the value of the ImageDistanceUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetImageDistanceUnit

public void resetImageDistanceUnit()

Resets the ImageDistanceUnit attribute to an unset state.

No description available in the XSD standard.

function hasImageDistanceUnit

public boolean hasImageDistanceUnit()

Checks whether the optional ImageDistanceUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFrontFocalLength

public void setFrontFocalLength(
    float value
)

Sets the value of the FrontFocalLength attribute.

Parameters:

value The value to set

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

function getFrontFocalLength

public float getFrontFocalLength()

Returns the value of the FrontFocalLength attribute.

Return: The value of the attribute

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

function resetFrontFocalLength

public void resetFrontFocalLength()

Resets the FrontFocalLength attribute to an unset state.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

function hasFrontFocalLength

public boolean hasFrontFocalLength()

Checks whether the optional FrontFocalLength attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

function setFrontFocalLengthUnit

public void setFrontFocalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the FrontFocalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getFrontFocalLengthUnit

public UnitsLength_Type getFrontFocalLengthUnit()

Returns the value of the FrontFocalLengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetFrontFocalLengthUnit

public void resetFrontFocalLengthUnit()

Resets the FrontFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

function hasFrontFocalLengthUnit

public boolean hasFrontFocalLengthUnit()

Checks whether the optional FrontFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setBackFocalLength

public void setBackFocalLength(
    float value
)

Sets the value of the BackFocalLength attribute.

Parameters:

value The value to set

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

function getBackFocalLength

public float getBackFocalLength()

Returns the value of the BackFocalLength attribute.

Return: The value of the attribute

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

function resetBackFocalLength

public void resetBackFocalLength()

Resets the BackFocalLength attribute to an unset state.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

function hasBackFocalLength

public boolean hasBackFocalLength()

Checks whether the optional BackFocalLength attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

function setBackFocalLengthUnit

public void setBackFocalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the BackFocalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getBackFocalLengthUnit

public UnitsLength_Type getBackFocalLengthUnit()

Returns the value of the BackFocalLengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetBackFocalLengthUnit

public void resetBackFocalLengthUnit()

Resets the BackFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

function hasBackFocalLengthUnit

public boolean hasBackFocalLengthUnit()

Checks whether the optional BackFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setParfocalizingDistance

public void setParfocalizingDistance(
    float value
)

Sets the value of the ParfocalizingDistance attribute.

Parameters:

value The value to set

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

function getParfocalizingDistance

public float getParfocalizingDistance()

Returns the value of the ParfocalizingDistance attribute.

Return: The value of the attribute

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

function resetParfocalizingDistance

public void resetParfocalizingDistance()

Resets the ParfocalizingDistance attribute to an unset state.

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

function hasParfocalizingDistance

public boolean hasParfocalizingDistance()

Checks whether the optional ParfocalizingDistance attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the distance between the mounting Plane of this Objective and the specimen Plane.

function setParfocalizingDistanceUnit

public void setParfocalizingDistanceUnit(
    UnitsLength_Type value
)

Sets the value of the ParfocalizingDistanceUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getParfocalizingDistanceUnit

public UnitsLength_Type getParfocalizingDistanceUnit()

Returns the value of the ParfocalizingDistanceUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetParfocalizingDistanceUnit

public void resetParfocalizingDistanceUnit()

Resets the ParfocalizingDistanceUnit attribute to an unset state.

No description available in the XSD standard.

function hasParfocalizingDistanceUnit

public boolean hasParfocalizingDistanceUnit()

Checks whether the optional ParfocalizingDistanceUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef

public void setAnnotationRef(
    AnnotationRef value
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef

public AnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

function hasAnnotationRef

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is a simple multi-line comment or annotation describing this component.

function __internal_create

public static Objective __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Protected Functions Documentation

function Objective

protected Objective(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

function getCPtr

protected static long getCPtr(
    Objective obj
)

Updated on 2026-02-13 at 16:11:05 +0100